home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / tag_bbs / top15100.zip / TOP15.DOC < prev    next >
Text File  |  1993-03-09  |  16KB  |  348 lines
  1. ════════════════════════════════════════════════════════════════════════════════
  2.                    Top 15 Files Downloaded Bulletin Generator
  3.                               
  4.                              -=< Version 1.00 >=-
  5.  
  6.                             Written by Joe McElmeel
  7.  
  8.                    Original idea and code by David Mitchell.
  9. ════════════════════════════════════════════════════════════════════════════════
  10.   
  11.      Subject                                                    Search For   
  12.     -----------------------------------------------------------------------         
  13.      The general features of Top 15 ............................... 0A
  14.      How to upgrade ............................................... 0B
  15.      Warranty and compatibility information ....................... 0C
  16.      Distribution information ..................................... 0D
  17.      First time setup information ................................. 0E
  18.      Explanation of all the features .............................. 0F
  19.      What to look for in future releases .......................... 0G
  20.      Support information .......................................... 0H
  21.      Other TNT Software Products .................................. 0I
  22.      Contacting the authors ....................................... 0J
  23.      Acknowledgements ............................................. 0K
  24.  
  25. ╔══════════════════════════════════════════════════════════════════════════════╗
  26. ║ ░░░ FEATURES ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0A░ ║
  27. ╚══════════════════════════════════════════════════════════════════════════════╝
  28.  
  29. "|" Denotes that this feature was not in David Mitchell's Top 15.
  30.  
  31.         o Top 15 is 100% *FREEWARE*.
  32.         o Configurable path & filename to write the output file to.
  33. |       o Runs in two modes, turbo (VERY fast) and normal.
  34. |       o Supports both "@" and "`" in the filename in the file board editor.
  35. |       o No messy text configuration files to play with.
  36. |       o Includes a fully-featured Setup program.
  37. |       o Configurable colors for the output file.
  38. |       o Fully supports Multi-Node systems, and uses file sharing/locking.
  39. |       o Uses TAG's Control-P color codes instead of raw ANSI.
  40. |       o Written and compiled in Borland's Turbo Pascal v7.0.
  41. |       o Supports an unlimited number of files, using little memory.
  42.  
  43.  For a complete list of revisions, see REVISION.DOC included with the archive.
  44.  
  45. ╔══════════════════════════════════════════════════════════════════════════════╗
  46. ║ ░░░ UPGRADING FROM OLDER VERSIONS ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0B░ ║
  47. ╚══════════════════════════════════════════════════════════════════════════════╝
  48.  
  49.    If you currently run David Mitchell's Top 15, I'm sorry, but you'll simply
  50. have to re-create the data file with Setup.
  51.  
  52.    No upgrade options are available.
  53.  
  54. ╔══════════════════════════════════════════════════════════════════════════════╗
  55. ║ ░░░ WARRANTY / COMPATIBILITY ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0C░ ║
  56. ╚══════════════════════════════════════════════════════════════════════════════╝
  57.  
  58.    This product is provided "as is" without warranty of any kind.  The entire
  59. risk as to the results and performance of the program is assumed by you.
  60. Futhermore, I, the author do not warrant, guarantee, or make any represent-
  61. tions regarding the use of, or the results of the use of the program, and you
  62. rely on the program and results solely at your own risk. I the author cannot
  63. accept responsibility for system damage, loss of profit, or any other special,
  64. incidental, or consequential damages resulting from the use or inability to
  65. use this product.
  66.  
  67.    However, we will be more than willing to support you, and help figure out
  68. any problems that you may have with out program(s).
  69.  
  70.    Top 15 has been compressed with a registered version of PKLITE by PKWARE,
  71. with the extra compression switch, to ensure you there has been no viruses
  72. inserted into the software, and this is, in fact, authentic.
  73.  
  74.    Top 15 has been tested on a very wide range of systems, some running Net-
  75. works, some running multi-taskers, and "average Joe" systems like mine. :)
  76.  
  77. ╔══════════════════════════════════════════════════════════════════════════════╗
  78. ║ ░░░ DISTRIBUTION INFORMATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0D░ ║
  79. ╚══════════════════════════════════════════════════════════════════════════════╝
  80.  
  81.    You are free, in fact encouraged, to distribute the software to anyone that
  82. runs a TAG system, provided that all files contained in this original archive
  83. are distributed in their original unmodified state.
  84.  
  85.    Just as long as it is the latest standard release!
  86.  
  87. ╔══════════════════════════════════════════════════════════════════════════════╗
  88. ║ ░░░ SETUP INFORMATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0E░ ║
  89. ╚══════════════════════════════════════════════════════════════════════════════╝
  90.  
  91.    Make sure you have TOP15.EXE from the archive in any directory that you wish.
  92.  
  93.    Execute TOP15 with the "/S" command line parameter, or if you wish to edit
  94. a different configuration file besides the default, "TOP15.DAT", run Top 15
  95. with two command line parameters like so:
  96.  
  97.         TOP15 [Path:\]CONFIG.DAT /S
  98.  
  99.    Simply choose the option(s) on the menu that you wish to change; most will be
  100. self-explanatory. You will probably *HAVE* to change at least the paths section.
  101.  
  102. Explanation of non self-explanatory options:
  103. -------------------------------------------
  104.  
  105.  Show area numbers    : Set this to "Yes" if you want Top 15 to show the phys-
  106.                         ical file section numbers that the files are located in.
  107.                         Keep in mind; this is NOT the dynamic number according
  108.                         to the user's access, it's the REAL number.
  109.  
  110.  Turbo Mode           : Enabling this option will make it so that Top 15 will
  111.                         not display ANYTHING to the screen while processing.
  112.                         This *GREATLY* increases the speed. I would suggest
  113.                         this mode if you have a particularly slow system or
  114.                         an awful lot of files for Top 15 to look through.
  115.  
  116.    Top 15 worked with and without SHARE.EXE loaded, but I think it would be
  117. wise to load it, especially in a multi-node environment. Top 15 detects SHARE,
  118. and is fully aware of it. There have been no reported problems loading it high
  119. with QEMM or similar drivers.
  120.  
  121. When/where to execute Top 15:
  122. ----------------------------
  123.  
  124.    You can run Top 15 from any directory on the system, just as long as your
  125. configuration data file is in the same directory as you execute it. That is,
  126. unless you specify a path as well as the filename as the first command line
  127. parameter.
  128.  
  129.    You can run it manually or in a midnight maintenance batch file or any other
  130. time you want. I'd suggest running it in a batch file daily unless you have a
  131. VERY high number of files on the system.
  132.  
  133.    In the batch file, you execute Top 15 with a single command line parameter
  134. if you wish to use an alternate config file, otherwise just 'TOP15' is fine.
  135.  
  136. @ECHO OFF
  137. CD\TAG
  138. NEWLOG -N1 -L Generating Top 15 Files
  139. TOP15                                   <---- Like so.
  140. NEWLOG -N1 -L Top 15 Files Done
  141. CD\TAG
  142.  
  143. NOTE: If no paramter is given, "TOP15.DAT" is used as a default, as stated be-
  144.       fore.
  145.  
  146. Menu command setup:
  147. ------------------
  148.  
  149.    You must make a menu command that displays the configurable output file.
  150.  
  151.    It looks exactly like this on my system:
  152.  
  153. Menu name       : ((( The Galaxy BBS Main Menu ))) #1
  154. Command number  : 28
  155. 1. Long desc.   : [/T]op 15 files on The Galaxy BBS.
  156. 2. Short desc.  : [/T]op 15 Files
  157. 3. Key          : /T
  158. 4. General SL   : 10
  159. 5. AR flag      : @
  160. 6. Program key  : !
  161. 7. Program data : "@TOP15"
  162. F. Flags        : SL access check, GSL and AR, Normal Command, No Linking
  163.  
  164. Commands on this menu: 28
  165.  
  166. Command Edit: (1-7,F,[,],B,J,Q,T,?):
  167.                           
  168.    That's pretty much it for set-up, once you get used to it and/or receive
  169. some feedback from your users you may want to change the default colors, etc.
  170.  
  171. ╔══════════════════════════════════════════════════════════════════════════════╗
  172. ║ ░░░ EXPLANATION OF FEATURES AVAILABLE ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0F░ ║
  173. ╚══════════════════════════════════════════════════════════════════════════════╝
  174.  
  175. "Blocking out" certain file boards
  176. ----------------------------------
  177.  
  178. If for any reason you wish to "block out" a file board from being used by Top
  179. 15, you can do it by doing this:
  180.  
  181.    Make a text file in the Top 15 directory called "EXEMPT.LST".
  182.  
  183.    The text file is just a list of file board numbers that you want Top 15 to
  184. simply ignore and not even look at. Uses for this could be for SysOps that have
  185. Adult files and don't want people to know that "SEXMEUP.GIF" is the top down-
  186. loaded file on the entire system. :)
  187.  
  188. Here's an example EXEMPT.LST:
  189.  
  190. 0
  191. 1
  192. 2
  193. 3
  194. 4
  195. 5
  196. 6
  197.  
  198. And that would block out file boards 0-6.
  199.  
  200. Make sure, for the fileboards with numbers less than ten (0-9) you do not put
  201. a preceding zero before the digit!
  202.  
  203. If you enter a number that is greater than the number of the last fileboard,
  204. Top 15 quits with an error message.
  205.  
  206. Other uses for the output file
  207. ------------------------------
  208.  
  209.    You may also wish to have Top 15 make its output to a bulletin.
  210.  
  211.    You can do this simply by having the output file option in Setup point to a
  212. bulletin that is currently not being used.
  213.  
  214.    For more information on working with bulletins, I advise you to refer to
  215. the T.A.G. BBS documentation available in TAGD26D.ZIP from 1:2410/480.
  216.  
  217. Writing to multiple output files
  218. --------------------------------
  219.  
  220.    If you want to block out the X-Rated GIFs section (or any other section)
  221. from your output file, you can do that. You can also have an output file that
  222. will look at nothing but your X-Rated GIFs section, if you like. You can do
  223. this by blocking out every file board but the GIFs, and then by making a com-
  224. mand in TAG accessible ONLY to Adults to view them.
  225.  
  226. Program Maintenance
  227. -------------------
  228.  
  229.              ▄██▄   ▄██▄  ▄███████▄  ▄██▄   ▄██▄ ▄█████████▄ ▄███▄ *
  230.              █████▄ ████ ████▀▀▀████ █████▄ ████ ████    ▀▀▀ █████
  231.              ███████████ ███     ███ ███████████ ████▄▄▄▄▄   █████
  232.              ████▀██████ ███     ███ ████▀██████ ████▀▀▀▀▀   █████
  233.              ████  ▀████ ████▄▄▄████ ████  ▀████ ████    ▄▄▄  ▀▀▀
  234.              ▀██▀   ▀██▀  ▀███████▀  ▀██▀   ▀██▀ ▀█████████▀  ███
  235.  
  236. * - The only maintenance is to make sure you run Top 15 periodically, if not
  237.     every night -- you don't want the listing to become stale.
  238.  
  239. ╔══════════════════════════════════════════════════════════════════════════════╗
  240. ║ ░░░ WHAT TO LOOK FOR IN FUTURE RELEASES ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0G░ ║
  241. ╚══════════════════════════════════════════════════════════════════════════════╝
  242.  
  243.    I am open for suggestions via the TAG echo or NetMail to 1:2410/480!
  244.  
  245. ╔══════════════════════════════════════════════════════════════════════════════╗
  246. ║ ░░░ SUPPORT INFORMATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0H░ ║
  247. ╚══════════════════════════════════════════════════════════════════════════════╝
  248.  
  249.   Thank you very much for trying Top 15, but we both know, there are going to be
  250. bugs in the software. Please send any questions, give any bug reports to, or
  251. call for support, to any of the following TNT support systems:
  252.  
  253.                                   Alpha Sites 
  254.                                   -----------
  255.  
  256. System Operator     Name of BBS             Fido Node    BBS Phone       Baud   
  257. --------------------------------------------------------------------------------
  258. Joe McElmeel      - The Galaxy BBS        - 1:2410/480 - (313)928-0522 - 14.4v *
  259. Rich Landskroener - The Emergency Scene   - 1:2410/480 - (313)941-2176 - 2400
  260. Jonathan Blair    - The Infinite Journey  - 1:2605/630 - (908)873-6988 - 14.4v *
  261.  
  262.                                    Beta Sites 
  263.                                    ----------
  264.  
  265. System Operator     Name of BBS             Fido Node    BBS Phone       Baud   
  266. --------------------------------------------------------------------------------
  267. Mark Watts        - The Mists of Time     - 1:2410/329 - (313)282-6149 - 14.4v *
  268. Alex McNeilly     - Chessplayer's Forum   - 1:2410/0   - (313)386-1884 - 16.8d
  269. Alex McNeilly     - Chessplayer's Forum   - 1:2410/278 - (313)386-7054 - 14.4h
  270. Bob Lechtanksi    - The Genuine Daze BBS  - 1:2200/807 - (313)449-5223 - 9600v
  271. Hawley Warren     - Egghead's Place       - 1:2410/297 - (313)537-5704 - 16.8d *
  272. Mike Coleman      - Ground Zero!          - 1:2410/339 - (313)561-9274 - 14.4v *
  273. Chris Bourne      - Law & Order BBS       - 1:2330/100 - (517)263-0273 - 14.4v
  274. Steve Bishop      - The Bushwacker BBS    - 1:3610/3   - (601)842-9255 - 14.4d
  275. Mike Lowe         - Marauder's Hideaway   - 1:112/99   - (904)731-5373 - 14.4v
  276.                        
  277.                        v = v.32 / v.32bis standard.
  278.                        h = US Robotics HST protocol.
  279.                        d = US Robotics HST/Dual Standard.
  280.  
  281.                        * = Has latest release for FREQ as "TOP15".
  282.  
  283.   (Most sites have TOP15 for FREQ, but the * denotes ones that are confirmed).
  284.  
  285. ╔══════════════════════════════════════════════════════════════════════════════╗
  286. ║ ░░░ OTHER PRODUCTS FROM TNT SOFTWARE ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0I░ ║
  287. ╚══════════════════════════════════════════════════════════════════════════════╝
  288.  
  289. NewLog Caller's Log - This program is a supplement to your plain-ASCII type log
  290.                       that TAG makes by default.
  291.    (Version 2.7)
  292.                       It supports SHARE, DESQview, MS-Windows, and more!
  293.  
  294.                       It is, of course, 100% FREEWARE just as Top 15 is.                      file on your system?
  295.  
  296.                       Colors for the log are completely configurable and the
  297.                       program supports two modes of logging callers or events!
  298.  
  299. This program is now available from 1:2410/480 as "NLOG27.ZIP" or "NEWLOG".
  300.  
  301. ╔══════════════════════════════════════════════════════════════════════════════╗
  302. ║ ░░░ CONTACTING THE AUTHOR  ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0J░ ║
  303. ╚══════════════════════════════════════════════════════════════════════════════╝
  304.  
  305. You can also get in contact with Joe McElmeel in the following ways:
  306.  
  307.    Joe McElmeel:
  308.    ------------
  309.  
  310.      US Mail:
  311.      
  312.         Joe McElmeel
  313.         18081 Koester 
  314.         Riverview, MI 48192-7416
  315.      
  316.      InterNet:
  317.      
  318.         bsc@tiamat.umd.umich.edu 
  319.         ccm10@umdsun1.umd.umich.edu -or- ccm10@umdsun2.umd.umich.edu
  320.  
  321.         I also frequent the IRC under the handle "Inferno".
  322.  
  323.      BBS:
  324.      
  325.         The Galaxy BBS; (313)928-0522, Lincoln Park, MI. 14400 v.32bis/v.42bis.
  326.         New users can access the messages, files, and Top 15 on the first call.
  327.    
  328.      Networks:
  329.      
  330.         SOGNet 91:7/4480, RPGNet 100:1313/501, CrossNet: 73:4100/12 and
  331.         FidoNet: 1:2410/480.
  332.  
  333.      FidoNet Echo Bases:
  334.      
  335.         FE_BETA, FE_HELP, {COMMO}, TAG, TAGMULTI, TAG_DOORS, and SRGAMES.
  336.  
  337. ╔══════════════════════════════════════════════════════════════════════════════╗
  338. ║ ░░░ ACKNOWLEDGEMENTS ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░0J░ ║
  339. ╚══════════════════════════════════════════════════════════════════════════════╝
  340.  
  341.         Thanks to David Mitchell for giving me the source code to his Top 15
  342. files generator a while back.
  343.  
  344.         Thanks to Paul Williams and Victor Capton for the T.A.G. v2.6d struct-
  345. ures as well as excellent BBS software.
  346.  
  347.                                      -EOF-
  348.